home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / COMMUNIC / COMMUTIL / 2258.ZIP / EZVIEW35.ZIP / EAZVIEW3.DOC < prev    next >
Text File  |  1990-04-05  |  19KB  |  450 lines
  1.  
  2.                                EAZVIEW3.EXE V3.55
  3.                                ------------------
  4.          Search and View files via EaziLink V3/EaziHost V1 Type 2 Door
  5.          -------------------------------------------------------------
  6.  
  7.      4th April 1990
  8.  
  9.      Disclaimer
  10.      ----------
  11.  
  12.      This program is being put  into  the  Public  Domain and may be freely
  13.      distributed  on  the  understanding  that  no  responsibility  can  be
  14.      accepted for any problems arising  from  its  use.  To the best of our
  15.      knowledge, it is 'Bug free' and serves its intended purpose.
  16.  
  17.      No charge, other than a nominal charge for duplication and postage may
  18.      be made for it and it should only  be supplied as a single ARC, ZIP or
  19.      PAK file called EAZVIEW3.ARC, EAZVIEW3.ZIP or EAZVIEW3.PAK, containing
  20.      the  EAZVIEW3.EXE,   EAZVIEW3.CNF,   EAZVIEW3.TXT,   EAZVIEW3.HLP  and
  21.      EAZVIEW3.DOC files.
  22.  
  23.  
  24.      The included files
  25.      ------------------
  26.  
  27.      EAZVIEW3.EXE   - The main program file.
  28.      EAZVIEW3.DOC   - The file you are now reading!
  29.      EAZVIEW3.CBF   - A sample configuration file.
  30.      EAZVIEW3.TXT   - A sample text intro file.
  31.      EAZVIEW3.HLP   - A sample Help file.
  32.  
  33.  
  34.      Note for users of earlier versions
  35.      ----------------------------------
  36.  
  37.      A new configuration option 'hostmain'  has  been added and is required
  38.      when used with  EaziHost,  but  is  only  necessary  if  the Host main
  39.      directory is not \EAZILINK\HOSTMAIN, when used with EaziLink.
  40.  
  41.  
  42.      Overview
  43.      --------
  44.  
  45.      EazView3 was created at the suggestion  of the SysOp of The Engineer's
  46.      Workbench BB, who  wanted  the  facility  to  let  callers  search for
  47.      programs in a number of  files  which  he possessed. The files contain
  48.      lists of programs on other Bulletin  Boards.  It may, however, be used
  49.      to view and search any ASCII text files.
  50.  
  51.      EazView3 functions as an EaziLink/EaziHost  Type  2 Doors program, but
  52.      it may also be used  from  the  MS-DOS  command prompt. IF ANSI.SYS is
  53.      loaded, or EaziLink/EaziHost is set up  for ANSI Display, any EaziLink
  54.      'pseudo ANSI' colour codes will be  acted  on  in the same way as they
  55.      are in EaziLink/EaziHost.
  56.  
  57.      Both the heading and the Menu  of  'files to search' may be configured
  58.      in much the same way as EaziLink's menus  and this is done by means of
  59.      entries in the EAZVIEW3.CNF file. See Configuration below.
  60.  
  61.  
  62.      Installing EazView3
  63.      -------------------
  64.  
  65.      EAZVIEW3.EXE and EAZVIEW3.CNF may be placed in any directory specified
  66.      by the path command, or they may  be  placed in any other directory AS
  67.      LONG AS  the  EaziLink/EaziHost  DOORS.HST  file  specifies  the  full
  68.      pathname.
  69.  
  70.      Installation is a two part process.  The DOORS.HST file requires a new
  71.      entry adding to implement EazView3  and  the EAZVIEW3.CNF file must be
  72.      configured to include  the  files  you  wish  to  search  and the file
  73.      descriptions required (Optionally most  other  features, such as menus
  74.      and prompts may be configured).
  75.  
  76.      The DOORS.HST file  should  be  edited  to  include  a  line  with the
  77.      following entries:-
  78.  
  79.      <validation>;Y;2;<descrip>;<progpathname> A%ansi E%expert H%hotkey
  80.  
  81.      <validation> is the Minimum  Validation  level  required for access to
  82.      EazView3.
  83.  
  84.      'Y' and '2' specify that 'recovery' is  required and that it is 'doors
  85.      type2 2' program respectively.
  86.  
  87.      <descrip> is the description to be displayed in the Doors Menu.
  88.  
  89.      <progpathname> is the full pathname for EAZVIEW3.EXE and EAZVIEW3.CNF,
  90.      if they are not  in  a  directory  specified  in  the  PATH command in
  91.      CONFIG.SYS. If the directory is  in  the  PATH,  then only the program
  92.      name is necessary.
  93.  
  94.      'A%ansi' is optional. '%ansi'  is  an  EaziLink  variable  and must be
  95.      preceded with the  letter  'A',  not  separated  by  any  spaces. This
  96.      determines which terminal emulation mode to use in EazView3.
  97.  
  98.      'E%expert' is optional. '%expert' is an  EaziLink variable and must be
  99.      preceded with the  letter  'E',  not  separated  by  any  spaces. This
  100.      determines whether 'Expert' menu mode is in use or not.
  101.  
  102.      'H%hotkey' is optional. '%hotkey' is an  EaziLink variable and must be
  103.      preceded with the  letter  'H',  not  separated  by  any  spaces. This
  104.      determines whether 'Quick key' menu selection is in use or not.
  105.  
  106.      By default, EazView3 selects  TTY  emulation, Menu selection requiring
  107.      Return and  displays  full  menus.  Usually  all  parameters  would be
  108.      included, so that the mode of  operation matched that currently in use
  109.      by the person using the BB.
  110.  
  111.      An example entry would be:-
  112.  
  113.      5;Y;2;Search Files;C:\eazilink\hostmain\eazview3.exe A%ansi E%expert
  114.  
  115.      'Search Files' will be displayed in  the  Doors  Menu and will only be
  116.      available to callers  with  a  Validation  level  of  5  or higher. As
  117.      'Q%quick' has  been  omitted,  EazView3  will  always  require  Return
  118.      pressing to confirm selections.
  119.  
  120.  
  121.      Setting up EAZVIEW3.CNF
  122.      -----------------------
  123.  
  124.      EazView3 is easily configured by  editing  the EAZVIEW3.CNF file. This
  125.      file serves several purposes. Firstly, it is used to specify the names
  126.      of the files  you  wish  to  make  available  for  searching and their
  127.      descriptions to be used  in  the  menu.  Secondly,  it  may be used to
  128.      configure messages, prompts and menus to suit your preferences. If you
  129.      omit the customisation options, defaults are  used  and these are of a
  130.      similar appearance to EaziLink's defaults.
  131.  
  132.      An example CNF file is included,  but it is recommended that initially
  133.      you  just  create  a  simple   one   containing  only  the  files  and
  134.      descriptions. The default settings for other  items will then be used.
  135.      The example CNF file contains some  odd colour schemes, to demonstrate
  136.      what can be done!
  137.  
  138.      Note:
  139.  
  140.      EaziLink pseudo codes may  be  included  in  any <text>,  <string>, or
  141.      <Description>  entries.  These  are  handled  in  the  same  way  that
  142.      EaziLink/EaziHost handles them.
  143.  
  144.      EazView3 also reads  the  COLOUR.HST  and  VERTICAL.MNU  files if they
  145.      exist and uses the colours  and  layouts  specified by these files for
  146.      the various menus and prompts,  UNLESS  they  are overridden by colour
  147.      codes specified in the EAZVIEW3.CNF file.
  148.  
  149.      As a result, unless you want  to  either  use different phrases, or to
  150.      force different colours from  the  main EaziLink/EaziHost program, you
  151.      are advised to leave  the  HEAD,  MENU,  XMENU,  SEARCH, NUMBER, MORE,
  152.      RETURN and VERT entries out of the  CNF file, so that the defaults are
  153.      used in matching colours to the main BB.
  154.  
  155.      1.  Entries for files to be available for searching.
  156.  
  157.          Required. At least one entry of this type is required, even if all
  158.          other configuration options are omitted.
  159.  
  160.          Upto 16 menu descriptions,  together  with  the  names of the files
  161.          may be specified, one to a line, in the form:-
  162.  
  163.          <Menu Description> ; <pathname>
  164.  
  165.          where '<Menu  Description>'  is  the  text  to  be  displayed  and
  166.          <pathname> is the full path and name of the file to be searched.
  167.  
  168.          NOTE: The  semi-colon  between  the  two  parts  of  the  entry  is
  169.          obligatory.
  170.  
  171.      2.  HOSTMAIN: <path>
  172.  
  173.          Required when used with  EaziHost,  but  it  is only required when
  174.          used with EaziLink Host mode  if  the EaziLink Host main directory
  175.          is not \EAZILINK\HOSTMAIN.
  176.  
  177.          <path>  is  the  full  path   from   the  root  directory  to  the
  178.          EaziLink/EaziHost Host main directory.
  179.  
  180.      3.  INTRO: <pathname>
  181.  
  182.          Optional. An introductory text file  may  be displayed, to explain
  183.          the purpose and use of the  program. It is immediately followed by
  184.          the menu. If the file is not  found, or this entry is omitted, the
  185.          menu is displayed immediately.
  186.  
  187.          <pathname> is the path and name  of  the file to be displayed. The
  188.          file may contain EaziLink pseudo codes.
  189.  
  190.      4.  HELP: <pathname>
  191.  
  192.          Optional. A help file may be  displayed, if found, otherwise a 'No
  193.          help available' message is displayed.
  194.  
  195.          <pathname> is the path and name of the help file to be displayed.
  196.          The file may contain EaziLink pseudo codes.
  197.  
  198.      5.  HEAD: <text>
  199.  
  200.          The menu heading may be  configured.  If  not specified, a default
  201.          heading is used.
  202.  
  203.          Example:-
  204.  
  205.          HEAD: This is the heading.
  206.  
  207.          EaziLink Pseudo codes my be incorporated.
  208.  
  209.          All the line, except for 'HEAD:' is displayed.
  210.  
  211.      6.  MENU: <string> and XMENU: <string>
  212.  
  213.          Optional. The selection menus may be configured. If not specified,
  214.          default  menus  are  used.  If   'Expert'   mode  is  selected  in
  215.          EaziLink/EaziHost when EazView3 is  called,  the  'expert' menu is
  216.          displayed. The standard and  Expert  menus  may  be specified with
  217.          lines as follows:-
  218.  
  219.          MENU: (S)can, (L)ist, (Q)uit:
  220.  
  221.          for standard the menu and
  222.  
  223.          XMENU: (S,L,Q):
  224.  
  225.          to configure the Expert menu as well.
  226.  
  227.          EaziLink Pseudo codes my be incorporated.
  228.  
  229.          'MENU:' and 'XMENU:' are not displayed.
  230.  
  231.          NOTE: the characters 'S', 'L', '?'  and  'Q' must be those used for
  232.          selection.
  233.  
  234.      7.  NUMBER: <text>
  235.  
  236.          Optional. The first  prompt  for  the  number  of  the  file to be
  237.          searched may be configured.
  238.  
  239.          Example:
  240.  
  241.          NUMBER: Enter number of file to search
  242.  
  243.          EaziLink pseudo codes may be incorporated.
  244.  
  245.          The word 'NUMBER:' is not displayed:
  246.  
  247.      8.  SEARCH: <text>
  248.  
  249.          Optional. Specifies the  wording  of  the  prompt  for  text to be
  250.          searched for.
  251.  
  252.          EaziLink pseudo codes may be incorporated.
  253.  
  254.          Example:
  255.  
  256.          SEARCH: Enter text to find:
  257.  
  258.          The word 'SEARCH:' is not displayed.
  259.  
  260.      9.  MORE: <text>
  261.  
  262.          Optional. The 'More Y/N' prompt may be changed.
  263.  
  264.          Eazilink pseudo codes may be incorporated.
  265.  
  266.          Example:
  267.  
  268.          MORE: Continue Y/N
  269.  
  270.          The word 'MORE:' is not displayed.
  271.  
  272.      10. RETURN: <text>
  273.  
  274.          Optional. The 'Press Return ' prompt may be changed.
  275.  
  276.          Eazilink pseudo codes may be incorporated.
  277.  
  278.          Example:
  279.  
  280.          RETURN: Press Return to continue.
  281.  
  282.          The word 'RETURN:' is not displayed.
  283.  
  284.      11. VERT: <string>
  285.  
  286.          Optional. This option is  now  largely  redundant  as EazView3 now
  287.          reads the VERTICAL.MNU file in the Host Main Directory.
  288.  
  289.          The numbering format in the  menu  list may also be configured. If
  290.          not specified, a default numbering  system  is used. The format may
  291.          be specified by a line as follows:-
  292.  
  293.          VERT: [*]
  294.  
  295.          The asterisk '*' marks  the  position  where  the option number is
  296.          required. All the line,  except  for  'VERT'  is displayed and the
  297.          asterisk '*' is converted to  the  appropriate number, or numbers,
  298.          when the options are displayed.
  299.  
  300.          In the above  example,  the  numbers  will  be  displayed inside a
  301.          matching pair of square brackets.
  302.  
  303.          EaziLink Pseudo codes my be incorporated.
  304.  
  305.  
  306.      Using EAZVIEW3
  307.      --------------
  308.  
  309.      Once EazView3 is installed, operation from within EaziLink/EaziHost is
  310.      automatic when selected from the  Doors  Menu.  If being used from the
  311.      DOS prompt, the syntax is:-
  312.  
  313.         EAZVIEW3 (AY|N|E) (EY|N) (HY|N)
  314.  
  315.      All parameters are optional, but, if used, should consist of 'A', 'E',
  316.      or 'H' followed by either 'Y'  or  'N'. The '|' symbol above indicates
  317.      'one or the other' and should not be entered. See Note below about the
  318.      'E' option in the first parameter.
  319.  
  320.      Once the  program  has  been  called,  a  list  of  files  to  view is
  321.      displayed, followed by a selection menu offering by default:-
  322.  
  323.         SEARCH: (S)earch, (L)ist, (!), (?), (Q)uit:
  324.  
  325.      (S)earch - results in a request for the file number to search.
  326.      (L)ist   - Re-displays the menu list.
  327.      (!)      - Save list to MAILBAG, for bulk download.
  328.      (?)      - Display Help file if configured and present.
  329.      (Q)uit   - Returns to EaziLink.
  330.  
  331.      Once Search has been selected  the  number  of  the  file to search is
  332.      requested, followed by a request for the 'Search String'.
  333.  
  334.      Only those lines of text which contain matching text are displayed. If
  335.      no text is specified for the Search  String, the search is aborted and
  336.      the menu redisplayed. Wildcards '*' and '?' may be used in the text to
  337.      be found and indicate '0 or more' and 'any 1' characters respectively.
  338.      More than one of each wildcard may be used. Using '*' will display the
  339.      complete file.
  340.  
  341.      Except in the  case  of  a  string  containing  only  an asterisk '*',
  342.      EazView3 automatically puts a '*' at  the  start and end of the search
  343.      string so that it may be found anywhere in the line.
  344.  
  345.      At the  end  of  each  screen,  a  'More?  Y/N'  prompt  is displayed.
  346.      Selecting 'N' will return to the menu, any other key will continue.
  347.  
  348.      Once all matching entries have  been  located,  the menu line will re-
  349.      appear for a further  selection.  Selecting  (S)earch  will repeat the
  350.      process, (L)ist will re-display the  file  list, or (Q)uit will return
  351.      to EaziLink/EaziHost.
  352.  
  353.      Display of text and file lists may be interrupted with Ctrl-C, as with
  354.      EaziLink V3/EaziHost.
  355.  
  356.      NOTE: A completely irrelevant  option  has  been  included in EAZVIEW3
  357.      which might prove useful on occasions. I needed it one day, so that is
  358.      why it is included!
  359.  
  360.      The facility allows you to convert  EaziLink pseudo ANSI files to true
  361.      ANSI files.
  362.  
  363.      Using:-
  364.  
  365.           EAZVIEW3 AE
  366.  
  367.      from the MS-DOS command prompt will  cause  a  request for the name of
  368.      the file to convert, followed by a request for an output filename. The
  369.      file will then be Exported to the new file as a true ANSI file.
  370.  
  371.  
  372.      Error Messages
  373.      --------------
  374.  
  375.      With the exception of  error  messages  which  occur through incorrect
  376.      parameters being passed to EazView3  (which  will  be picked up during
  377.      initial installation of the program), all system errors as a result of
  378.      incorrect paths, filenames etc are displayed  on screen AND written to
  379.      the SYSTEM.ERR file in the Host Main Directory.
  380.  
  381.      SYSTEM.ERR is created by EaziHost  and  provides  a convenient way for
  382.      the Sysop to check on errors.  If  no  SYSTEM.ERR file is found, a new
  383.      file will be created. The  entry  is  in  the  same  format as used by
  384.      EaziHost and includes the name  of  the  program  from which the error
  385.      originated, the current system date and a description of the error.
  386.  
  387.  
  388.      History
  389.      -------
  390.  
  391.      1.00  12/06/89 - Initial Beta Test release
  392.      1.01  13/06/89 - Included  facility  to   use   more  parameters  from
  393.                       EaziLink, such as Quick keys and Expert mode.
  394.      1.02  14/06/89 - Included further CNF file parameters to configure all
  395.                       prompts etc.
  396.      1.03  17/06/89 - Included option to  display  a  text  file  on entry,
  397.                       describing the use/purpose of the program.
  398.                     - Included (?) option on menu,  to display optional HLP
  399.                       file.
  400.                     - Included Ctrl-C checking  for  abort  current part of
  401.                       display. Works on  intro  text,  list  of options and
  402.                       during display of selected items.
  403.                     - Minor changes made to ANSI emulation.
  404.                     - Included a  parameter  to  allow  writing  of  a file
  405.                       containing EaziLink pseudo-codes  to  disk  as a true
  406.                       ANSI file. Of no use normally, but might be handy for
  407.                       a SysOp wanting to change from one file format to the
  408.                       other!
  409.      1.04  06/07/89 - Beta-test. Changed  /Q  parameter  to  /H,  to  match
  410.                       EaziLink V3
  411.      3.05  08/10/89 - First Release version for EaziLink V3.
  412.                     - Minor bug fix to clearing 'More' prompt.
  413.      3.06  11/10/89 - Facility to save to EaziLink Mailbag added.
  414.                     - Included host path in configuration options, required
  415.                       for mailbag.
  416.                     - Minor changes to default menus  to bring in line with
  417.                       EaziLink.
  418.      3.07  15/10/89 - Changes made to way 'More'  prompt  works, to make it
  419.                       more line noise proof. It now reacts only to Y, N, or
  420.                       RETURN.
  421.      3.08  17/10/89 - Inserted 'Not found' message at a Sysop's request.
  422.      3.09  30/11/89 - Speeded up searching in certain circumstances.
  423.      3.51  28/12/89 - Minor  changes  to  work  with  EaiHost  as  well  as
  424.                       EaziLink.
  425.      3.52  29/01/90 - System Errors are now  written  to SYSTEM.ERR file in
  426.                       Host Main Directory, in line with EaziHost
  427.                     - Program now makes use of Eazilink/EaziHost COLOUR.HST
  428.                       and VERTICAL.MNU files  if  they  exist. This reduces
  429.                       the need to use configuration  options just to change
  430.                       colours of prompts, messages etc.
  431.      3.55  04/04/90 - First full release for  use  with  both EaziLink Host
  432.                       and EaziHost V1.
  433.                     - Change made to the  way  pressing  Return  for a null
  434.                       search string is abandoned. It  is  no handled in the
  435.                       same way as EaziLink/EaziHost  and my other utilities
  436.                       and the search is aborted. To view all of a file, '*'
  437.                       is required.
  438.  
  439.  
  440.      David Foster
  441.      H.L.C. Services
  442.      High Leys
  443.      Crook
  444.      Kendal
  445.      Cumbria
  446.      LA8 8LF
  447.  
  448.                                       END
  449.  
  450.